|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface ProjectService
| Method Summary | |
|---|---|
void |
archiveVersion(User user,
java.lang.String projectKey,
java.lang.String versionName,
boolean archive)
|
RemoteProject |
createProject(User user,
RemoteProject rProject)
|
RemoteProject |
createProject(User user,
java.lang.String key,
java.lang.String name,
java.lang.String description,
java.lang.String url,
java.lang.String lead,
RemotePermissionScheme permissionScheme,
RemoteScheme notificationScheme,
RemoteScheme issueSecurityScheme)
|
RemoteVersion |
createVersion(User user,
java.lang.String projectKey,
RemoteVersion remoteVersion)
|
void |
deleteProject(User user,
java.lang.String projectKey)
|
void |
deleteProjectAvatar(User user,
long avatarId)
Deletes the given custom Avatar from the system. |
RemoteComponent[] |
getComponents(User user,
java.lang.String projectKey)
|
RemoteAvatar |
getProjectAvatar(User user,
java.lang.String projectKey,
java.lang.String size)
Retrieves the current Avatar for the given project. |
RemoteAvatar[] |
getProjectAvatars(User user,
java.lang.String projectKey,
boolean includeSystemAvatars,
java.lang.String size)
Retrieves avatars for the given project. |
RemoteProject |
getProjectById(User user,
java.lang.Long projectId)
Returns the Project with the matching id (if the user has permission to browse it). |
RemoteProject |
getProjectByKey(User user,
java.lang.String projectKey)
Returns the Project with the matching key (if the user has permission to browse it). |
RemoteProject[] |
getProjects(User user,
boolean addSchemes)
|
RemoteProject |
getProjectWithSchemesById(User user,
java.lang.Long projectId)
Returns the project with the matching id (if the user has permission to browse it) with notification, issue security and permission schemes attached. |
RemoteSecurityLevel[] |
getSecurityLevels(User user,
java.lang.String projectKey)
Return an array of Security Levels for a given project |
RemoteVersion[] |
getVersions(User user,
java.lang.String projectKey)
|
void |
releaseVersion(User user,
java.lang.String projectKey,
RemoteVersion remoteVersion)
|
void |
setProjectAvatar(User user,
java.lang.String projectKey,
java.lang.Long avatarId)
Sets the current avatar for the given project to that with the given id. |
void |
setProjectAvatar(User user,
java.lang.String projectKey,
java.lang.String contentType,
java.lang.String base64ImageData)
Creates a new custom avatar for the given project and sets it to be current for the project. |
RemoteProject |
updateProject(User user,
RemoteProject rProject)
|
| Method Detail |
|---|
RemoteProject[] getProjects(User user,
boolean addSchemes)
throws RemoteException
RemoteException
RemoteProject getProjectByKey(User user,
java.lang.String projectKey)
throws RemotePermissionException,
RemoteException
user - the authenticated User attempting to access the project. Permission checks are run against them.projectKey - the key of the requested after project
RemotePermissionException - if the User does not have permission to BROWSE the project.
RemoteException
RemoteProject getProjectById(User user,
java.lang.Long projectId)
throws RemoteException
user - the authenticated User attempting to access the project. Permission checks are run against them.projectId - the id of the requested after project
RemotePermissionException - if the User does not have permission to BROWSE the project.
RemoteException
RemoteProject getProjectWithSchemesById(User user,
java.lang.Long projectId)
throws RemoteException
user - the authenticated User attempting to access the project. Permission checks are run against them.projectId - the id of the requested after project
RemotePermissionException - if the User does not have permission to BROWSE the project.
RemoteException
RemoteComponent[] getComponents(User user,
java.lang.String projectKey)
throws RemoteException
RemoteException
RemoteVersion[] getVersions(User user,
java.lang.String projectKey)
throws RemoteException
RemoteException
RemoteProject createProject(User user,
java.lang.String key,
java.lang.String name,
java.lang.String description,
java.lang.String url,
java.lang.String lead,
RemotePermissionScheme permissionScheme,
RemoteScheme notificationScheme,
RemoteScheme issueSecurityScheme)
throws RemoteException
RemoteException
RemoteProject createProject(User user,
RemoteProject rProject)
throws RemoteException
RemoteException
RemoteProject updateProject(User user,
RemoteProject rProject)
throws RemoteException
RemoteException
void deleteProject(User user,
java.lang.String projectKey)
throws RemoteException
RemoteException
RemoteVersion createVersion(User user,
java.lang.String projectKey,
RemoteVersion remoteVersion)
throws RemoteException
RemoteException
void releaseVersion(User user,
java.lang.String projectKey,
RemoteVersion remoteVersion)
throws RemoteException
RemoteException
void archiveVersion(User user,
java.lang.String projectKey,
java.lang.String versionName,
boolean archive)
throws RemoteException
RemoteException
RemoteSecurityLevel[] getSecurityLevels(User user,
java.lang.String projectKey)
throws RemoteException,
RemotePermissionException
user - the authenticated User attempting to access the project. Permission checks are run against them.projectKey - the key of the requested project
RemoteException - If the project key is invalid or the Security Levels could not be retrieved
RemotePermissionException - If the User does not have Browse permission for the project
RemoteAvatar[] getProjectAvatars(User user,
java.lang.String projectKey,
boolean includeSystemAvatars,
java.lang.String size)
throws RemoteException,
RemotePermissionException
user - the user whos asking, must have BROWSE permission to the project.projectKey - the key for the project.includeSystemAvatars - if false, only custom avatars will be included in the returned array.size - "large" or "small".
RemoteException - If the project key is invalid.
RemotePermissionException - If you do not have Browse permission for the project.
void setProjectAvatar(User user,
java.lang.String projectKey,
java.lang.String contentType,
java.lang.String base64ImageData)
throws RemoteException
user - the user setting the avatar, must have PROJECT ADMIN permission to the project.projectKey - the key for the project.contentType - the MIME type of the image provided, e.g. image/gif, image/jpeg, image/png.base64ImageData - a base 64 encoded image, 48 pixels square.
RemoteException - If the project key is invalid.
RemotePermissionException - If you do not have project admin permission for the project.
void setProjectAvatar(User user,
java.lang.String projectKey,
java.lang.Long avatarId)
throws RemoteException
user - the user setting the avatar, must have PROJECT ADMIN permission to the project.projectKey - the key for the project.avatarId - the id of an existing avatar to use for the project or null for the default avatar.
RemoteException - If the project key is invalid.
RemotePermissionException - If you do not have project admin permission for the project.
RemoteAvatar getProjectAvatar(User user,
java.lang.String projectKey,
java.lang.String size)
throws RemoteException,
RemotePermissionException
user - the user whos asking, must have BROWSE permission to the project.projectKey - the key for the project.size - "large" or "small".
RemoteException - If the project key is invalid.
RemotePermissionException - If you do not have Browse permission for the project.
void deleteProjectAvatar(User user,
long avatarId)
throws RemoteException
user - the user whos asking, must have PROJECT ADMIN permission to the project.avatarId - id of the custom avatar to delete.
RemoteException - if there is no avatar with the given id, or if it is a system avatar.
RemotePermissionException - If you do not have administer permission for the project.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||